Skip to main content

Quick Doc Manager Guide

alt_text

Overview​

OpsAdmin's Document Management module supports regulatory compliance in the retail energy space by automating customer documentation, maintaining version control, and enabling multilingual support.

Key Capabilities:​

  • Automated Document Generation
  • Version Control with Historical Accuracy
  • Static PDF and Dynamic Template Support
  • On-Demand Regeneration
  • Tiered Market > Utility > Plan Configuration
  • Customer Language Preference Support

1. Document Types Setup​

Purpose​

Defines rules for how and where documents are used within the system.

Access​

  • Navigate to Settings > Document Types

Fields:​

  • Name – Name of the document type
  • Class – Plan or Prospect (used to trigger different fulfillment rules)
  • Level – Market, Utility, or Plan
  • Exclusive – Allows only one document of this type per level
  • Allow Override – Allows lower-tier documents to override higher-tier documents
  • Required – Forces plan versioning when documents of this type are modified or unpublished

Actions:​

  • Add – Click "+ Document Type New", complete required fields, and click Save
  • Edit – Click row, modify fields, then Save
  • Delete – Click trash icon and confirm (disabled if the type is in use)

2. Language Types​

Purpose​

Support multilingual document generation by uploading language-specific variants.

Access​

  • Navigate to Documents + Settings > Languages

Fields:​

  • Name – Full name of language

  • Short Name – Code used in backend (e.g., EN, ES)

  • Default – Only one can be set

  • Active – Determines whether the language can be selected

Actions:​

  • Add – Click "+ New Language", complete fields, then Save
  • Edit – Click row, modify, then Save
  • Delete – Not allowed once documents are tied to the language

3. Document Manager​

Purpose​

Central hub for managing all documents.

Access​

  • Navigate to Document Manager

Visible Attributes:​

  • Name, Document Type, Current Version
  • Associated Markets and Utilities
  • Available Languages
  • Search/Filter tools available

Functions:​

  • Add New Document

    • Click "+ New Document"
    • Complete mandatory fields
    • Click Add Language Variant
      • Select File (upload PDF) or Template (select dynamic template)
      • Click OK, then Save
    • Note: At least one language variant is required to save

  • Add New Version

    • Click 3-dot icon > Add Version
    • Select version type, upload or choose template
    • Save

  • View Version History

    • Click 3-dot icon > Show Version History
    • All previous versions and comments are shown

  • Download Preview

    • Click 3-dot icon > Download Document (generates PDF)

4. Dynamic Templates​

Purpose​

Create data-driven HTML templates that convert to PDF at generation.

Access​

  • Navigate to Dynamic Templates

Actions:​

  • Add – Click "+ New Dynamic Document", fill in admin section, build content using Word-style or HTML editor, click Save
  • Edit – Select row, modify content, click Save
  • Delete – Click 3-dot icon > Delete > Confirm
  • Generate Sample PDF
    • Click 3-dot icon > Generate Sample PDF
    • Enter customer confirmation number (from Enrollment Manager), click Generate, and download

Template Fields:​

  • Name
  • Document Type
  • Use in HTML Editor (optional toggle)
  • Use as Thank You Page (optional toggle)
  • Content Area – Word-style editor or Source Code editor
  • Available Variables – Pull customer-specific data dynamically

5. Document Implementation​

Structure​

Documents are implemented at 3 levels:

  • Market

  • Utility

  • Plan

    Default inheritance flows from Market → Utility → Plan. Behavior can be adjusted via Document Type settings (Exclusive / Override).

6. Market and Utility Document Management​

Adding a Document​

  1. Navigate to the Market or Utility
  2. Go to Associated Documents
  3. Click + Add Document
  4. Select Document and Type
  5. (For Utility Level) Select Market first, then Utility
  6. Configure Display & Communication Rules
  7. Click Save

Managing Documents​

  • Publish – Must be checked for document to be active
  • Edit – Click pencil icon, make changes, then Save
  • Delete – Removes association only (does not delete document)
  • Display/Communication Rules – Toggle checkboxes inline

7. Plan-Level Document Management​

Adding a Document to a Plan​

  1. Go to Web Plans > Select Utility > Select Plan
  2. Click the Documents tab
  3. Click Add Document
  4. Choose document, configure properties, click Save
  5. Confirm plan version creation

Editing a Plan-Level Document​

  • Click 3-dot icon next to document
  • Add version or variant as needed
  • Click Save
  • Confirm new plan version when prompted

This guide is designed to provide a structured reference for configuring, managing, and maintaining documents across the OpsAdmin platform.